doc/user: use Materialize-dialect SQL syntax highlighting #26222
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Syntax highlighting in our docs uses a general SQL highlighter. This is fine, but we don't have highlighting on Mz-specific keywords, which is suboptimal. I have upstreamed Materialize SQL dialect highlighting to Chroma, the highlighting library used by Hugo. The most recent Hugo release includes it! So, this PR:
.File
beingnil
on pages without a directly attributable file (e.g., directories without an_index.md
).Before
After
If we're happy with this, and once it's merged, I'll work on formalizing the Chroma dialect update motion as a script so we can upstream new keywords as they land.
Tips for reviewer
Sorry for the large diff! If you'd prefer I introduce this section by section I can break up the PR.
Checklist
$T ⇔ Proto$T
mapping (possibly in a backwards-incompatible way), then it is tagged with aT-proto
label.